Skip to main content

Update your logo

You can update the logo that will be shown to every customer of The Fork Manager. Please use the uuid value that you got from the previous API call as URL parameter.

URL:

  • Production environment: PUT https://api.thefork.io/pos/v1/{uuid}/logo

HEADER:

  • X-Api-Key: API key generated in the previous steps
  • Content-Type: multipart/form-data

FORM:

  • logo: (string) path to your logo image file. The logo should be in PNG format, have a minimum width of 300px, and a maximum size of 100Kb.

Request example:

curl --request PUT \
  --url https://api.preprod.thefork.io/pos/v1/${UUID}/logo \
  --header "X-Api-Key: ${API_KEY}" \
  --header 'Content-Type: multipart/form-data' \
  --form 'logo=@"path/to/your/logo.png"'

Response example (HTTP 200):

{
    "name": "Your POS Company name",
    "type": "jwt",
    "homepageUrl": "https://example.com/something",
    "receiptOpeningUrl": "https://pos.webhook/order",
    "oauthAuthorizeUrl": null,
    "oauthTokenUrl": null,
    "oauthScope": [],
    "availableOn": [],
    "logoPath": "489cdb94-3c20-4f63-b189-2b095bb879ac.png",
    "uuid": "489cdb94-3c20-4f63-b189-2b095bb879ac"
}

Response error codes:

  • 400 (incorrect payload)
  • 401 (no authorization)
  • 404 (uuid not found)
  • 415 (wrong content-type value)
  • 500 (general error, you are invited to retry later)